home *** CD-ROM | disk | FTP | other *** search
/ MACD 5 / MACD 5.bin / workbench / tools / czesc_2 / frequest / frequest.doc < prev    next >
Text File  |  1978-01-10  |  13KB  |  332 lines
  1.  
  2.  
  3.  
  4.                     Documentation FRequest Version 1.55
  5.  
  6.  
  7.                             written 1993
  8.  
  9.  
  10.                         ® 1992/93 by H.P.G  FREEWARE
  11.  
  12.  
  13.  
  14. Index:
  15.  
  16.     Overview
  17.     Changes
  18.     History
  19.     Legal Stuff
  20.     Features
  21.     Start Parameters
  22.     Installation
  23.     Tutorial
  24.     Technical
  25.  
  26.  
  27. Overview:
  28.  
  29.         FRequest runs only under OS >= 2.xx.
  30.  
  31.         FRequest is a powerful tool which  enables  you,  to  select  a
  32.         file by using the ASL filerequester and then execute almost every
  33.         program with the selected file or dir name.
  34.         FRequest (FR) uses a lot of OS 2.xx features so it is  not  able
  35.         to run under 1.3 or 1.2.
  36.  
  37.         The requester is full user definable. That means you CAN specify
  38.         a lot of the settings but you don`t HAVE to do this.
  39.  
  40.         There are a lot of PARAMETERS you can specify.  Look  below  for
  41.         further details (Section PARAMETERS).
  42.  
  43.         FR has the ability to start a given command line  as  if  it has
  44.         been typed directly in a shell window. The command line has the
  45.         same syntax as an alias for the AMIGAShell. All '[]' are replaced
  46.         by the selection(s) if there is one.
  47.  
  48.         You can use FR also to start programs on  its  own  without  any
  49.         arguments or parameters.
  50.  
  51.  
  52. Changes:
  53.              from Version 1.5 to 1.55:
  54.  
  55.                     Three new  command line options has been added.
  56.  
  57.                     HEIGHT=G/K/N  specifies the height of the requester.
  58.  
  59.                     MULTI=M/S     starts the requester in multiples file
  60.                                   mode to give you the ability to chose
  61.                                   more than one files at the same time.
  62.  
  63.                     SAVE=S/S      starts the filerequester in save mode.
  64.  
  65.                     Also I removed some enforcer hits. That`s why I got a
  66.                     new A4000 and a new enforcer version which runs an those
  67.                     systems.
  68.  
  69. History:
  70.  
  71.     Version 1.5     First general release.
  72.  
  73.     Version 1.51    Removed some enforcer hits.
  74.  
  75.     Version 1.52    Added new Save option. Removed some enforcer hits.
  76.  
  77.     Version 1.53    Added new Multiples option. Added the ability to specify
  78.                     the height of the filerequester.
  79.  
  80.     Version 1.55    Removed some Enforcer hits and fixed some little bugs.
  81.                     Second general release.
  82.  
  83.  
  84. Legal Stuff:
  85.  
  86.  
  87.         This program and all files come with it also  the  doc files  are
  88.         released as FREEWARE.
  89.  
  90.         this means:
  91.  
  92.             everybody may use FRequest,
  93.  
  94.             everybody may copy FRequest, if:
  95.  
  96.                 1.  you  copy  all  included  files   see   list   below
  97.                 2. no changes are made , this means the program amd  all
  98.                    included  files  must  stay  in  the  original  form.
  99.  
  100.                    Exception: you may archive it ; but in this way  you
  101.                    must also archive the whole package.
  102.                 3. if you decompile it, you have to include a notice  to
  103.                    the  original   author.   if   you   also   want   to
  104.                    (re)distribute this program in the new form you  have
  105.                    to send me a copy.
  106.                 4. you may not sell FRequest
  107.                    Exception: you`re allowed to take a  small  copy  fee
  108.                               which may not extend 5$.
  109.                 5. if you  want  to  include  FRequest  or  one  of  the
  110.                    included files as a part  of  a  commercial  package,
  111.                    you  must  have  written  permission  of  the  author
  112.                    (address see below)
  113.  
  114.  
  115.         I take no warranty or guaranty for the function of this  program.
  116.         The whole risk of using it stays by the user.
  117.  
  118. Features:
  119.  
  120.             You  can  specify  the directory displayed in the dir string
  121.             gadget  of  the  requester.  If  you do not the current work
  122.             directory is inserted.
  123.  
  124.             You can specify the file displayed in the file string gadget.
  125.             If you do not it stays empty
  126.  
  127.             You  can  specify  patterns  displayed in the pattern string
  128.             gadget. If you do not '#?' is inserted.
  129.  
  130.             You can specify the positive and the  negative  gadget  text
  131.             of the requester. If you do  not  they  contain  'OKAY'  and
  132.             'CANCEL'.
  133.  
  134.             You can chose a hail string for the  title  of  the requester
  135.             if you do not 'Please Select a File' will be used.
  136.  
  137.             You can specify the height of the filerequester.
  138.  
  139.             You can use FRequest in multiselect mode, that means you may
  140.             chose multiples files at the same time with shift left mouse-
  141.             button. The selection can be done which double clicking on the
  142.             last file.
  143.  
  144.             You can use the save option. This opens the filerequester in
  145.             a different color and the double click selection is disabled,
  146.             for security.
  147.  
  148.             You can specify a  commandline that  will  be  sent  to  the
  149.             shell by replacing the '[]'s with the selection. If  you  do
  150.             not inlude a '[]' then the selection will be simply added to
  151.             the end of the specified commandline.
  152.  
  153.             If you do not specify a command line the  selection  will  be
  154.             sent to STOUT e.g. the SHELL  window  but  the  command line
  155.             will not be executed (this is very useful  for  testing  the
  156.             settings or the  commandline  without  executing  anything).
  157.  
  158.             You can also call FR to start  a  cli  program  without  any
  159.             commandline.
  160.  
  161.             You can switch on the QUIET flag. No information  about  the
  162.             selection will then be putted to STOUT.
  163.  
  164.  
  165.  
  166. Start Parameters:
  167.  
  168.             FR has the following CLI SYNTAX:
  169.             ( look at the AmigaDOS doc for more details about flags)
  170.  
  171.  
  172.     Syntax:   Frequest [HAIL/K][OK/K][CANCEL/K][DIR/K][FILE/K][PAT/K][HeiGht=G/K/N]
  173.                        [SAVE=S/S][MULTI=M/S][QUIET/S][EXE/S|COM/K]
  174.  
  175.  
  176.     Description:
  177.  
  178.                 HAIL:   this should be a string. If more than  one  word
  179.                         is given, the string must  be  embedded in  "".
  180.                         This is the title of the requester. The  default
  181.                         title is 'Please Select A File'
  182.  
  183.                 OK:     this should  be  a  string  with  at  maximum  8
  184.                         characters length.  This  is  the  text  of  the
  185.                         positive gadget. The  default  text  is  'OKAY'.
  186.  
  187.                 CANCEL: this should  be  a  string  with  at  maximum  8
  188.                         characters length.  This  is  the  text  of  the
  189.                         negative gadget. The default text  is  'CANCEL'.
  190.  
  191.                 DIR:    this is also  a  string.  If  you  specify  this
  192.                         option the requester opens with  displaying  the
  193.                         specified directory. The  default  directory  is
  194.                         the current work directory.
  195.  
  196.                 FILE:   this is also  a  string.  If  you  specify  this
  197.                         option the requester opens with  displaying  the
  198.                         specified  filename  in  the  file string gadget.
  199.                         The default Filename is ''
  200.  
  201.                 PAT:    this is also  a  string.  If  you  specify  this
  202.                         option the requester opens  with  the  specified
  203.                         patterns in the pattern string gadget.
  204.                         If you do not specify PAT no pattern gadget will
  205.                         be displayed.
  206.                         The default pattern is '#?'.
  207.  
  208.                 HEIGHT: This is the height of the filerequester in pixel.
  209.                         The maximum height depends on your viewmode and
  210.                         your wbench screensize.
  211.                         The default is not to specify any height.
  212.  
  213.                 MULTI:  This is also a new option. If you specify this,
  214.                         you may chose more than one file. You can hold
  215.                         down the shift button and chose other files with
  216.                         the left mousebutton. To end the selection and
  217.                         leave the requester just doubleclick on the last
  218.                         chosen file.
  219.                         The default: not enabled.
  220.  
  221.                 SAVE:   Specifying this will bring up the filerequester in
  222.                         a different color. This should show you that the
  223.                         doubleclick selection is now disabled. This should
  224.                         be used for security by saving operations.
  225.                         The default: not enabled.
  226.  
  227.                 QUIET:  this is a BOOLEAN flag. FR usually displayes the
  228.                         command line before execution. If you do not want
  229.                         this, you can specify QUIET. (  this  is  useful
  230.                         e.g in batchfiles with an AUTO  shell  window ).
  231.                         The default is FALSE
  232.  
  233.                 EXE:    this is a BOOLEAN flag. If you  do  not  specify
  234.                         COM  (see  below)  and  not  EXE  then  FR  only
  235.                         displays the selection in the Shell  window.  If
  236.                         you specify EXE then FR executes  the  selection
  237.                         without any arguments as a program.
  238.  
  239.                 COM:    this is a  string.  The  length  should  not
  240.                         extend 255 chars. This is  the command line
  241.                         that FR tries to  execute. You  must  embed  the
  242.                         commandline with "" s.  If  this  line  includes
  243.                         some '[]', then these will be exchanged with the
  244.                         selection(s). If you do`nt specify any '[]'  then
  245.                         the selection will simply be added to the end  of
  246.                         the given command line.
  247.  
  248.                 OTHERS: In general if you  canceled  the  requester,  no
  249.                         command will be executed and no output  will  be
  250.                         made. If you just  want  to  test  the  settings
  251.                         you`ve  made,  you  can  call  FRequest  without
  252.                         specifying EXE and COM.
  253.  
  254.                         If you specify COM and EXE, FR  just  terminates
  255.                         and displayes a short help text.  This  is  also
  256.                         if you put any incorrect commandline to FRequest.
  257.  
  258.  
  259. Installation:
  260.  
  261.                 Very simple. Just copy FRequest to your C: directory  or
  262.                 any other directory in your AmigaDOS  search path.  done.
  263.  
  264. Tutorial:
  265.                 1. Here is the simplest example of calling FR
  266.  
  267.                 SHELL 1.> FRequest
  268.  
  269.                 - FR openes the requester with the title
  270.                   'Please  Select  File'  and  displayes  the   contents
  271.                   of  the  current  directory.  The  gadget  texts   are
  272.                   'OKAY'  and  'CANCEL'.  if  you  do  a  selection  the
  273.                   result will  be  prompted  to  the  Cli  window.  e.g.
  274.  
  275.                 Testing: Df0:system/setmap ...
  276.  
  277.                 2. To use FR in an alias to reassign the fonts dir.
  278.  
  279.                 SHELL 1.> alias FAss FRequest HAIL "Please Select the New
  280.                           FONTS: DIR" OK "ASSIGN" CANCEL "STOP" COM
  281.                           "assign fonts:"
  282.  
  283.                 SHELL 1.> FAss
  284.  
  285.                 - FR opens the requester with the title  'Please  Select
  286.                   the New FONTS: DIR' and displays the contents of  the
  287.                   current directory.
  288.                   The gadget texts are 'ASSIGN' and 'STOP'. If you do  a
  289.                   selection the result will be added to the  commandline
  290.                   and  be  executed  as:
  291.  
  292.                         assign fonts: <selection>
  293.  
  294.                 3. Specifying almast all what is to specify. This is an
  295.                    example to copy one or more files or a whole directory
  296.                    to Ram:. Therefor we use the new Multiple option.
  297.  
  298.                 SHELL 1.>  Frequest HAIL "What File(s) should I copy ?"
  299.                            OK "COPY" M PAT "#?.(c|h)" COM "copy [] to RAM:"
  300.  
  301.  
  302. Technical:
  303.  
  304.             FR is written in MANX Aztec C  Compiler  Version  5.2a.  Its
  305.             size is relatively small  (  unlike  other  programs  of  this
  306.             kind ). This is because of using a  lot  of  system  library
  307.             calls instead of using C.lib functions.
  308.  
  309.  
  310. Address:
  311.  
  312.  
  313.                 Hans-Peter Guenther
  314.                 Gruener Weg 5
  315.                 3501 Fuldatal 2
  316.                 Germany
  317.  
  318. List of files:
  319.  
  320.    (If you miss any of the files below your release is incomplete)
  321.  
  322.    FRequest            : The english binary
  323.    FRequest.info
  324.    FRequest_D          : The german binary
  325.    FRequest_D.info
  326.    FRequest.doc        : The english manual
  327.    FRequest.doc.info
  328.    FRequest.dok        : The german manual
  329.    FRequest.dok.info
  330.  
  331. --End
  332.